dba/com.verint.xm.sdk/[androidJvm]DBA

DBA

open class DBA : BaseProduct, Product

Created by alan.wang on 3/8/18.

Constructors

constructor()

Types

DBATestGroupKey

enum DBATestGroupKey

Used to specify AB testing groups within DBA

Properties

open var config: IConfiguration

Functions

open fun addProducts()

checkIfProductExists

open fun checkIfProductExists(product: Product.Products): Boolean

completeProductInitialization

open fun completeProductInitialization(application: Application, oldConfig: IConfiguration, newConfig: IConfiguration)

open fun disable()

open fun enable()

open fun getIsStarted(): Boolean

open fun getMaskedViews(): List<WeakReference<View>>

DBA: gets the list of masked views (actually, WeakReferences to the view).

open fun getTestGroup(key: String): String

Retrieve the value previously set using setTestGroup

initStubInstance

open fun initStubInstance()

open fun isCoreStarted(): Boolean

open fun isPaused(): Boolean

Check if DBA is paused

open fun isRecording(): Boolean

Check if DBA is recording

logDBAPageChange

open fun logDBAPageChange(name: String)

Programmatically log a DBA page change event.

open fun logFeatures(application: Application, configuration: IConfiguration)

open fun maskView(view: View)

DBA: adds a specific View persistenceSerializer to the list of views that are to be masked during capture.

onRequestPermissionsResult

open fun onRequestPermissionsResult(requestCode: Int, @NotNull permissions: Array<String>, @NotNull grantResults: Array<Int>)

Accepts the result of the request to show notifications.

open fun pauseRecording()

DBA: pauses recording indefinitely

open fun pauseRecording(pauseRecordingForMilliseconds: Long)

DBA: pauses recording until indefinitely

open fun prepareProduct(application: Application, configuration: IConfiguration): Boolean

registerInterfaceActivity

open fun registerInterfaceActivity()

Registers activity within a custom scroller to prevent captures interfering with scroll animations.

requestBeginRecording

open fun requestBeginRecording()

* Requests that the SDK begin recording the screen This function will cause a permissions dialog to be displayed, asking the user for permission to record the screen.

resetCaptureRate

open fun resetCaptureRate()

Resets the DBA capture rate the the default.

resetProductState

open fun resetProductState()

resetRecordingPermission

open fun resetRecordingPermission()

Allows implementers to reset recording permission to default value of NotSet.

resumeRecording

open fun resumeRecording()

DBA: resumes recording

open fun setCaptureRate(captureRate: Int)

Sets the DBA capture rate.

setMaskingDebugEnabled

open fun setMaskingDebugEnabled(maskingDebugEnabled: Boolean)

Allows implementers to debug the masking within the app by adding a colored overlay indicating masked areas

setRecordingPermission

open fun setRecordingPermission(enabled: Boolean)

Allows implementers to enable recording by calling API directly or by their own implemented custom prompt

open fun setRecordingPermission(option: RecordingPermissionOption)

Allows implementers to enable recording by calling API directly or by their own implemented custom prompt with some extra options including the ability to enable recording for one session only

open fun setTestGroup(key: String, groupName: String)

Define a group name for AB testing The SDK will log the relative success of each group

open fun stopProduct()

open fun stopRecording()

Stops the SDK recording the screen

open fun unmaskView(view: View)

DBA: removes a View persistenceSerializer from the list of views that are to be masked during capture.

open fun validateConfig(json: String): Boolean